Development: Document Jenkins and LocalVC setup
#9266
Conversation
- only rename title yet - Adjust label in the old file to get old links reference to the new jenkins-localvc documentation
GitLab also supports token for authentification but LocalVC does not.
GitLab to Jenkins pushes does not exist anymore. Therefore also remove the parts about this from the Jenkins-GitLab documentation.
The yml file have to be different between localvc and gitlab setup.
Unmodified version from develop branch
WalkthroughThe changes include updates to the documentation for the Artemis development environment, specifically regarding the integration of version control and continuous integration tools. The primary modification is the introduction of "LocalVC and Jenkins" as the recommended setup, replacing the deprecated "GitLab and Jenkins." Additionally, a new guide for setting up Jenkins with LocalVC has been added, detailing prerequisites and configuration steps. The documentation has also been refined to reflect the upcoming removal of GitLab support and streamline setup processes. Changes
Possibly related PRs
Suggested labels
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (1)
Additional comments not posted (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range comments (3)
docs/dev/setup.rst (1)
Line range hint
1-89: Overall, the changes look good but could benefit from additional context.The updates to the integration stacks and toctree are consistent with the PR objectives. The new "LocalVC and Jenkins" setup is added, and "GitLab and Jenkins" is correctly marked as deprecated. The toctree is updated to include the new setup file.
To improve clarity for users, consider adding a brief explanation about the transition from GitLab to LocalVC, as suggested in the previous comment. This would help users understand the reason for these changes and guide them towards the new recommended setup.
docs/dev/setup/jenkins-localvc.rst (2)
Line range hint
793-798: Consider adding a brief explanation of cachingWhile it's good to reference the administration documentation for more details, it would be helpful to include a brief explanation of what caching is used for in this context (e.g., improving build performance, reducing network usage). This would give readers a better understanding of why they might want to configure caching.
Line range hint
1-798: Overall, excellent and comprehensive documentationThis documentation provides a thorough guide for setting up Jenkins and LocalVC with Artemis. The content is well-structured and covers all necessary aspects of the setup process. To further improve the document:
- Consider adding a table of contents at the beginning for easier navigation.
- Include version numbers for the software being discussed (e.g., Jenkins, Docker) to help readers understand if the instructions are applicable to their specific versions.
- Add troubleshooting tips or a FAQ section to address common issues users might encounter during the setup process.
These additions would make the documentation even more user-friendly and comprehensive.
| @@ -868,87 +859,6 @@ GitLab Repository Access | |||
| continuous-integration: | |||
| vcs-credentials: the.id.of.the.username.and.password.credentials.from.jenkins | |||
|
|
|||
| GitLab to Jenkins push notification token | |||
There was a problem hiding this comment.
Note for other reviewers: For quite some time now Artemis sends the notification directly to Jenkins instead of relying on a Webhook from GitLab to Jenkins. Therefore, this token is no longer required.
Co-authored-by: Benedikt Fein <[email protected]>
Co-authored-by: Benedikt Fein <[email protected]>
Co-authored-by: Benedikt Fein <[email protected]>
Co-authored-by: Benedikt Fein <[email protected]>
This is the url for jenkins to access LocalVC / Artemis, therefore localhost is wrong here. Instead it have to connect to the docker host.
Use localhost for accessing LocalVC to have a nicer cloning url, similar to GitLab (where it was only a different port of localhost).
BaumiCoder
dismissed stale reviews from dfuchss, b-fein, and coderabbitai[bot]
via
d579a60
krusche
changed the title
Development: Document Jenkins and LocalVC SetupDevelopment: Document Jenkins and LocalVC setup
krusche
deleted the
feature/programming-exercises/document-localvc-jenkins
branch
Checklist
General
Server
Only changes in the documentation
Client
Only changes in the documentation
Motivation and Context
Using Artemis with Jenkins as the CI system is still a valuable option, but GitLab support will be removed from Artemis. Another VCS for Jenkins can be LocalVC. For this new combination there is no documentation yet to set this up from scratch. For migrating existing installation there is PR #8972 (Issue #8754).
Description
A documentation for using Artemis with Jenkins and LocalVC. It is adjusted copy of the documentation for Jenkins and GitLab, which will be removed with 8.0.0 (see 8202bda). In addition, also small changes for the Jenkins and GitLab documentation (mark it as deprecated and remove old parts about GitLab to Jenkins pushes).
Steps for Testing
Nothing to test - Only changes in the documentation
Review Progress
Code Review
Summary by CodeRabbit
Summary by CodeRabbit